home *** CD-ROM | disk | FTP | other *** search
/ SGI Performance Co-Pilot 1.3 / SGI Performance Co-Pilot 1.3.iso / dist / pcp.idb / usr / share / catman / u_man / cat3 / PMAPI / vkpcptimer.z / vkpcptimer
Text File  |  1997-04-03  |  7KB  |  128 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr((((3333xxxx))))                                                  VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkPCPtimer - timer interface for the the X main loop.
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkCallbackObject
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <PCP/VkPCPtimer.h>
  16.  
  17. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  18.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  19.          VkPCPtimer();
  20.          virtual ~VkPCPtimer();
  22.    SSSSttttaaaarrrrttttiiiinnnngggg aaaannnndddd SSSSttttooooppppppppiiiinnnngggg
  23.         void start(int interval);
  24.         void stop(void);
  26. PPPPRRRROOOOTTTTEEEECCCCTTTTEEEEDDDD PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  27.    UUUUppppddddaaaatttteeeessss
  28.         virtual void tick(void);
  30. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  31.      VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr provides a simple interface to the Xt timeout mechanism, as
  32.      described in XXXXttttAAAAppppppppAAAAddddddddTTTTiiiimmmmeeeeOOOOuuuutttt(3x).  Applications create an instance of the
  33.      VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr class, register a callback function, and call the ssssttttaaaarrrrtttt(((())))
  34.      method.  The callback function will be called at the appropriate time
  35.      from the Xt main loop.  It is the responsibility of the application to
  36.      schedule the next timer.  This is usually done at the end of the callback
  37.      function itself.
  38.  
  39.  
  40.  
  41. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  42.    ttttiiiicccckkkk(((())))
  43.          virtual void tick(void);
  45.           This virtual function can be overridden by derived classes to allow
  46.           them to be notified when each timeout occurs.
  47.  
  48.    VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr(((())))
  49.          VkPCPtimer();
  51.           The constructor initializes a VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr object.
  52.  
  53.    ~~~~VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr(((())))
  54.          virtual void ~VkPCPtimer(void);
  56.  
  57.  
  58.  
  59.  
  60.                                                                         PPPPaaaaggggeeee 1111
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67. VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr((((3333xxxx))))                                                  VVVVkkkkPPPPCCCCPPPPttttiiiimmmmeeeerrrr((((3333xxxx))))
  68.  
  69.  
  70.  
  71.           Clean up all memory allocated by a VkPCPtimer object.  Any pending
  72.           timer is removed.
  73.  
  74.    ssssttttaaaarrrrtttt(((())))
  75.          void start(int interval)
  77.           Start the timer. This function must be called to start the timer.
  78.           The ttttiiiicccckkkk (((()))) method and all registered callbacks will be called after
  79.           _i_n_t_e_r_v_a_l milliseconds.  If the _i_n_t_e_r_v_a_l parameter is negative or
  80.           zero, the ccccaaaallllllllCCCCaaaallllllllbbbbaaaacccckkkkssss (((()))) inherited member function will be called
  81.           immediately and no timer will be scheduled.  The ssssttttaaaarrrrtttt (((()))) method
  82.           must be called again for the next timer.  If a periodic timer is
  83.           required, the ttttiiiicccckkkk() method or a registered callback can call the
  84.           ssssttttaaaarrrrtttt method again to reschedule the timer.  If a regular, real-time
  85.           synchronized timer is required, applications should measure the time
  86.           difference between successive timer callbacks, and adjust the inter-
  87.           val accordingly.
  88.  
  89.    ssssttttoooopppp(((())))
  90.          void stop(void);
  92.           Stop the timer, cancel and pending timer events.
  93.  
  94.    ssssttttaaaattttiiiicccc ccccoooonnnnsssstttt cccchhhhaaaarrrr ****ccccoooonnnnsssstttt ttttiiiimmmmeeeerrrrCCCCaaaallllllllbbbbaaaacccckkkk;;;;
  95.          static const char *const timerCallback;
  97.           This callback list allows other C++ classes derived from
  98.           VkCallbackObject to register member functions to be called at
  99.           periodic intervals.
  100.  
  101. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  102.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
  103.         callCallbacks(), addCallback(), removeCallback(), removeAllCallbacks()
  105. CCCCLLLLAAAASSSSSSSSEEEESSSS UUUUSSSSEEEEDDDD BBBBYYYY TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  106.      VkPCParchiveTime, VkPCPliveTime
  107.  
  108. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  109.      VkPCParchiveTime, VkPCPliveTime
  110.      VkPeriodic, VkWindow, VkComponent, VkCallbackObject, VkMenu, VkMenuBar,
  111.      VkMenuItem
  112.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  113.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  114.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  115.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.                                                                         PPPPaaaaggggeeee 2222
  125.  
  126.  
  127.  
  128.